<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="assuredworkloads_v1.html">Assured Workloads API</a> . <a href="assuredworkloads_v1.organizations.html">organizations</a> . <a href="assuredworkloads_v1.organizations.locations.html">locations</a> . <a href="assuredworkloads_v1.organizations.locations.workloads.html">workloads</a> . <a href="assuredworkloads_v1.organizations.locations.workloads.violations.html">violations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#acknowledge">acknowledge(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves Assured Workload Violation based on ID.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, interval_endTime=None, interval_startTime=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="acknowledge">acknowledge(name, body=None, x__xgafv=None)</code>
  <pre>Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.

Args:
  name: string, Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for acknowledging the violation
  &quot;acknowledgeType&quot;: &quot;A String&quot;, # Optional. Acknowledge type of specified violation.
  &quot;comment&quot;: &quot;A String&quot;, # Required. Business justification explaining the need for violation acknowledgement
  &quot;nonCompliantOrgPolicy&quot;: &quot;A String&quot;, # Optional. This field is deprecated and will be removed in future version of the API. Name of the OrgPolicy which was modified with non-compliant change and resulted in this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for violation acknowledgement
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Retrieves Assured Workload Violation based on ID.

Args:
  name: string, Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Workload monitoring Violation.
  &quot;acknowledged&quot;: True or False, # A boolean that indicates if the violation is acknowledged
  &quot;acknowledgementTime&quot;: &quot;A String&quot;, # Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false.
  &quot;associatedOrgPolicyViolationId&quot;: &quot;A String&quot;, # Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations.
  &quot;auditLogLink&quot;: &quot;A String&quot;, # Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}
  &quot;beginTime&quot;: &quot;A String&quot;, # Output only. Time of the event which triggered the Violation.
  &quot;category&quot;: &quot;A String&quot;, # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.
  &quot;description&quot;: &quot;A String&quot;, # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.
  &quot;exceptionAuditLogLink&quot;: &quot;A String&quot;, # Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization}
  &quot;exceptionContexts&quot;: [ # Output only. List of all the exception detail added for the violation.
    { # Violation exception detail.
      &quot;acknowledgementTime&quot;: &quot;A String&quot;, # Timestamp when the violation was acknowledged.
      &quot;comment&quot;: &quot;A String&quot;, # Business justification provided towards the acknowledgement of the violation.
      &quot;userName&quot;: &quot;A String&quot;, # Name of the user (or service account) who acknowledged the violation.
    },
  ],
  &quot;name&quot;: &quot;A String&quot;, # Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}
  &quot;nonCompliantOrgPolicy&quot;: &quot;A String&quot;, # Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}
  &quot;orgPolicyConstraint&quot;: &quot;A String&quot;, # Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.
  &quot;parentProjectNumber&quot;: &quot;A String&quot;, # Optional. Output only. Parent project number where resource is present. Empty for org-policy violations.
  &quot;remediation&quot;: { # Represents remediation guidance to resolve compliance violation for AssuredWorkload # Output only. Compliance violation remediation
    &quot;compliantValues&quot;: [ # Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values
      &quot;A String&quot;,
    ],
    &quot;instructions&quot;: { # Instructions to remediate violation # Required. Remediation instructions to resolve violations
      &quot;consoleInstructions&quot;: { # Remediation instructions to resolve violation via cloud console # Remediation instructions to resolve violation via cloud console
        &quot;additionalLinks&quot;: [ # Additional urls for more information about steps
          &quot;A String&quot;,
        ],
        &quot;consoleUris&quot;: [ # Link to console page where violations can be resolved
          &quot;A String&quot;,
        ],
        &quot;steps&quot;: [ # Steps to resolve violation via cloud console
          &quot;A String&quot;,
        ],
      },
      &quot;gcloudInstructions&quot;: { # Remediation instructions to resolve violation via gcloud cli # Remediation instructions to resolve violation via gcloud cli
        &quot;additionalLinks&quot;: [ # Additional urls for more information about steps
          &quot;A String&quot;,
        ],
        &quot;gcloudCommands&quot;: [ # Gcloud command to resolve violation
          &quot;A String&quot;,
        ],
        &quot;steps&quot;: [ # Steps to resolve violation via gcloud cli
          &quot;A String&quot;,
        ],
      },
    },
    &quot;remediationType&quot;: &quot;A String&quot;, # Output only. Reemediation type based on the type of org policy values violated
  },
  &quot;resolveTime&quot;: &quot;A String&quot;, # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.
  &quot;resourceName&quot;: &quot;A String&quot;, # Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations.
  &quot;resourceType&quot;: &quot;A String&quot;, # Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations.
  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the violation
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last time when the Violation record was updated.
  &quot;violationType&quot;: &quot;A String&quot;, # Output only. Type of the violation
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, interval_endTime=None, interval_startTime=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using &#x27;-&#x27; (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`

Args:
  parent: string, Required. The Workload name. Format `organizations/{org_id}/locations/{location}/workloads/{workload}`. (required)
  filter: string, Optional. A custom filter for filtering by the Violations properties.
  interval_endTime: string, The end of the time window.
  interval_startTime: string, The start of the time window.
  pageSize: integer, Optional. Page size.
  pageToken: string, Optional. Page token returned from previous request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response of ListViolations endpoint.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The next page token. Returns empty if reached the last page.
  &quot;violations&quot;: [ # List of Violations under a Workload.
    { # Workload monitoring Violation.
      &quot;acknowledged&quot;: True or False, # A boolean that indicates if the violation is acknowledged
      &quot;acknowledgementTime&quot;: &quot;A String&quot;, # Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false.
      &quot;associatedOrgPolicyViolationId&quot;: &quot;A String&quot;, # Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations.
      &quot;auditLogLink&quot;: &quot;A String&quot;, # Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}
      &quot;beginTime&quot;: &quot;A String&quot;, # Output only. Time of the event which triggered the Violation.
      &quot;category&quot;: &quot;A String&quot;, # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.
      &quot;description&quot;: &quot;A String&quot;, # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.
      &quot;exceptionAuditLogLink&quot;: &quot;A String&quot;, # Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization}
      &quot;exceptionContexts&quot;: [ # Output only. List of all the exception detail added for the violation.
        { # Violation exception detail.
          &quot;acknowledgementTime&quot;: &quot;A String&quot;, # Timestamp when the violation was acknowledged.
          &quot;comment&quot;: &quot;A String&quot;, # Business justification provided towards the acknowledgement of the violation.
          &quot;userName&quot;: &quot;A String&quot;, # Name of the user (or service account) who acknowledged the violation.
        },
      ],
      &quot;name&quot;: &quot;A String&quot;, # Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}
      &quot;nonCompliantOrgPolicy&quot;: &quot;A String&quot;, # Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}
      &quot;orgPolicyConstraint&quot;: &quot;A String&quot;, # Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.
      &quot;parentProjectNumber&quot;: &quot;A String&quot;, # Optional. Output only. Parent project number where resource is present. Empty for org-policy violations.
      &quot;remediation&quot;: { # Represents remediation guidance to resolve compliance violation for AssuredWorkload # Output only. Compliance violation remediation
        &quot;compliantValues&quot;: [ # Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values
          &quot;A String&quot;,
        ],
        &quot;instructions&quot;: { # Instructions to remediate violation # Required. Remediation instructions to resolve violations
          &quot;consoleInstructions&quot;: { # Remediation instructions to resolve violation via cloud console # Remediation instructions to resolve violation via cloud console
            &quot;additionalLinks&quot;: [ # Additional urls for more information about steps
              &quot;A String&quot;,
            ],
            &quot;consoleUris&quot;: [ # Link to console page where violations can be resolved
              &quot;A String&quot;,
            ],
            &quot;steps&quot;: [ # Steps to resolve violation via cloud console
              &quot;A String&quot;,
            ],
          },
          &quot;gcloudInstructions&quot;: { # Remediation instructions to resolve violation via gcloud cli # Remediation instructions to resolve violation via gcloud cli
            &quot;additionalLinks&quot;: [ # Additional urls for more information about steps
              &quot;A String&quot;,
            ],
            &quot;gcloudCommands&quot;: [ # Gcloud command to resolve violation
              &quot;A String&quot;,
            ],
            &quot;steps&quot;: [ # Steps to resolve violation via gcloud cli
              &quot;A String&quot;,
            ],
          },
        },
        &quot;remediationType&quot;: &quot;A String&quot;, # Output only. Reemediation type based on the type of org policy values violated
      },
      &quot;resolveTime&quot;: &quot;A String&quot;, # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.
      &quot;resourceName&quot;: &quot;A String&quot;, # Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations.
      &quot;resourceType&quot;: &quot;A String&quot;, # Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations.
      &quot;state&quot;: &quot;A String&quot;, # Output only. State of the violation
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last time when the Violation record was updated.
      &quot;violationType&quot;: &quot;A String&quot;, # Output only. Type of the violation
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>